right logo image
right logo image
Log on
⯆

API Explorer

Log off

v4.0.0 (541 APIs)

API Host: https://obp-apisandbox.joinfincubator.com
Bank
Accounts
Views
Counterparties
Transactions

Create new Book Mark Bank And Account System

Create new Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanCreateDynamicEntity_SystemBookMarkBankAndAccount_system - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_createBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Create new My Book Mark Bank And Account System

Create new My Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_createMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Delete Book Mark Bank And Account System by id

Delete Book Mark Bank And Account System by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_SystemBookMarkBankAndAccount_system - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_deleteBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Delete My Book Mark Bank And Account System by id

Delete My Book Mark Bank And Account System by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_deleteMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account System List

Get Book Mark Bank And Account System List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount_system?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system_list":[{
    "book_mark_bank_and_account_system":{
      "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_SystemBookMarkBankAndAccount_system - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getBookMarkBankAndAccount_systemList_, operation_id: OBPv4.0.0-dynamicEntity_getBookMarkBankAndAccount_systemList_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account System by id

Get Book Mark Bank And Account System by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanGetDynamicEntity_SystemBookMarkBankAndAccount_system - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_getSingleBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account System List

Get My Book Mark Bank And Account System List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount_system?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system_list":[{
    "book_mark_bank_and_account_system":{
      "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyBookMarkBankAndAccount_systemList_, operation_id: OBPv4.0.0-dynamicEntity_getMyBookMarkBankAndAccount_systemList_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account System by id

Get My Book Mark Bank And Account System by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Update Book Mark Bank And Account System

Update Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_SystemBookMarkBankAndAccount_system - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_updateBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,

Update My Book Mark Bank And Account System

Update My Book Mark Bank And Account System.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount_system"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "book_mark_bank_and_account_system":{
    "bookMarkBankAndAccount_systemId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_SystemBookMarkBankAndAccount_system - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyBookMarkBankAndAccount_system_, operation_id: OBPv4.0.0-dynamicEntity_updateMyBookMarkBankAndAccount_system_ Tags: _Book Mark Bank And Account System, Dynamic-Entity, Dynamic,